Metadata-Version: 2.1
Name: Mastodon Reader
Version: 0.1.0
Summary: Mastodon project file reader for Python
Home-page: https://git.ist.ac.at/csommer/mastodon_reader
Author: Christoph Sommer
Author-email: christoph.sommer23@gmail.com
License: BSD
Description: # Mastodon Reader for Python
        Import the *spots and links tables*, *features*, *tags* and meta data from a *Mastodon project file*.
        
        ported to Python from: [Matlab importer](https://github.com/mastodon-sc/matlab-mastodon-importer)
        
        ## Example
        Read the mastodon file:
        
        ```python
        from mastodon_reader import MastodonReader
        
        mr = MastodonReader("demo/mamutproject.mastodon")
        
        # show meta data
        meta_data = mr.read_metadata()
        
        # read (networkX) graph representation, spot and link tables with features and tags columns
        graph, spots, links, tag_definition = mr.read(tags=True, features=True)
        
        ```
        or read information separately
        
        ```python
        # read only spot and link tables
        spots, links = mr.read_tables()
        
        # read tag_definition and add tags as new columns to the spot and link tables
        tag_definition = mr.read_tags(spots, links)
        
        # read features and add as new columns to the spot and link tables
        mr.read_features(spots, links)
        
        # create networkX DiGraph representation form spots and links
        graph = mr.create_nx_graph(spots, links)
        ```
        
        ## Installation
        #### Current version
        `pip install git+git://github.com/sommerc/mastodon_reader.git`
        
        #### pip
        `pip install mastodon_reader`
        
        #### Dependencies
        * numpy
        * pandas
        * networkx
        
        
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Description-Content-Type: text/markdown
